docs: Clarify autoclosing issues syntax

Link to the GitLab documentation, and clarify that if no single commit
in a merge requests closes an issue, you should add a reference to the
issue in the commit message anyway.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b1aef7a3dc2fe01d13dd3588571cb8a7a560cf72..8fffe4d678d4257877f65cecb1650c32cb7fbf84 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -194,25 +194,22 @@ Closes #1234
  - When committing code on behalf of others use the `--author` option, e.g.
  `git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`.
 
- - If your commit is addressing an issue, use the GitLab syntax to
- automatically close the issue on push:
+ - If your commit is addressing an issue, use the
+ [GitLab syntax](https://docs.gitlab.com/ce/user/project/issues/automatic_issue_closing.html)
+ to automatically close the issue when merging the commit with the upstream
+ repository:
 
 ```plain
 Closes #1234
-```
-
-  or:
-
-```plain
 Fixes #1234
-```
-
-  or:
-
-```plain
 Closes: https://gitlab.gnome.org/GNOME/gtk/issues/1234
 ```
 
+ - If you have a merge request with multiple commits and none of them
+ completely fixes an issue, you should add a reference to the issue in
+ the commit message, e.g. `Bug: #1234`, and use the automatic issue
+ closing syntax in the description of the merge request.
+
 ### Access to the GTK repository
 
 GTK is part of the GNOME infrastructure. At the current time, any